<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, height=device-height, initial-scale=1, user-scalable=no">
  <meta name="description" content="API docs for the FlutterSoundPlayer class from the flutter_sound_player library, for the Dart programming language.">
  <title>FlutterSoundPlayer class - flutter_sound_player library - Dart API</title>


  
  <link rel="preconnect" href="https://fonts.gstatic.com">
  <link href="https://fonts.googleapis.com/css2?family=Roboto+Mono:ital,wght@0,300;0,400;0,500;0,700;1,400&display=swap" rel="stylesheet">
  <link href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@24,400,0,0" rel="stylesheet">
  
  <link rel="stylesheet" href="../static-assets/github.css?v1">
  <link rel="stylesheet" href="../static-assets/styles.css?v1">
  <link rel="icon" href="../static-assets/favicon.png?v1">
  
</head>

<body data-base-href="../" data-using-base-href="false" class="light-theme">
<div id="overlay-under-drawer"></div>
<header id="title">
  <span id="sidenav-left-toggle" class="material-symbols-outlined" role="button" tabindex="0">menu</span>
  <ol class="breadcrumbs gt-separated dark hidden-xs">
    <li><a href="../index.html">flutter_sound</a></li>
    <li><a href="../public_flutter_sound_player">public&#47;flutter_sound_player.dart</a></li>
    <li class="self-crumb">FlutterSoundPlayer class</li>
  </ol>
  <div class="self-name">FlutterSoundPlayer</div>
  <form class="search navbar-right" role="search">
    <input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
  </form>
  <div class="toggle" id="theme-button" title="Toggle brightness">
    <label for="theme">
      <input type="checkbox" id="theme" value="light-theme">
      <span id="dark-theme-button" class="material-symbols-outlined">
        dark_mode
      </span>
      <span id="light-theme-button" class="material-symbols-outlined">
        light_mode
      </span>
    </label>
  </div>
</header>
<main>
<div
    id="dartdoc-main-content"
    class="main-content"
    data-above-sidebar="public_flutter_sound_player&#47;public_flutter_sound_player-library-sidebar.html"
    data-below-sidebar="public_flutter_sound_player&#47;FlutterSoundPlayer-class-sidebar.html">
    <div>
<h1><span class="kind-class">FlutterSoundPlayer</span> class 
 
</h1></div>

    
<section class="desc markdown">
  <p>A Player is an object that can playback from various sources.</p>
<hr>
<p>The Player class can have multiple instances at the same time. Each instance is used to control the sound of its source.</p>
<p>The sources possible can be:</p>
<ul>
<li>A file</li>
<li>A remote URL</li>
<li>An internal buffer</li>
<li>A dart stream</li>
</ul>
<p>Using a player is very simple :</p>
<ol>
<li>
<p>Create a new <a href="../public_flutter_sound_player/FlutterSoundPlayer/FlutterSoundPlayer.html">FlutterSoundPlayer()</a></p>
</li>
<li>
<p>Open it with <a href="../public_flutter_sound_player/FlutterSoundPlayer/openPlayer.html">openPlayer()</a></p>
</li>
<li>
<p>Start your playback with <a href="../public_flutter_sound_player/FlutterSoundPlayer/startPlayer.html">startPlayer()</a>.</p>
</li>
<li>
<p>Use the various verbs (optional):</p>
<ul>
<li><a href="../public_flutter_sound_player/FlutterSoundPlayer/pausePlayer.html">pausePlayer()</a></li>
<li><a href="../public_flutter_sound_player/FlutterSoundPlayer/resumePlayer.html">resumePlayer()</a></li>
<li><a href="../public_flutter_sound_player/FlutterSoundPlayer/setVolume.html">setVolume()</a></li>
<li>...</li>
</ul>
</li>
<li>
<p>Stop your player : <a href="../public_flutter_sound_player/FlutterSoundPlayer/stopPlayer.html">stopPlayer()</a></p>
</li>
<li>
<p>Release your player when you have finished with it : <a href="../public_flutter_sound_player/FlutterSoundPlayer/closePlayer.html">closePlayer()</a>.
This verb will call <a href="../public_flutter_sound_player/FlutterSoundPlayer/stopPlayer.html">stopPlayer()</a> if necessary.</p>
</li>
</ol>
<p><img src="/images/PlayerStates.png" alt="Player States">
<em>Player States</em></p>
<p>If you are new to Flutter Sound, you may have a look to this <a href="/tau/guides/guides_getting-started.html">little guide</a></p>
<hr>
</section>



    
  <section class="summary offset-anchor" id="constructors">
    <h2>Constructors</h2>
    <dl class="constructor-summary-list">
        <dt id="FlutterSoundPlayer" class="callable">
          <span class="name"><a href="../public_flutter_sound_player/FlutterSoundPlayer/FlutterSoundPlayer.html">FlutterSoundPlayer</a></span><span class="signature">({<span class="parameter" id="-param-logLevel"><span class="type-annotation"><a href="https://pub.dev/documentation/logger/2.5.0/logger/Level.html">Level</a></span> <span class="parameter-name">logLevel</span> = <span class="default-value">Level.debug</span>, </span><span class="parameter" id="-param-voiceProcessing"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span> <span class="parameter-name">voiceProcessing</span> = <span class="default-value">false</span></span>})</span>
        </dt>
        <dd>
          Instanciates a new Flutter Sound player.
        </dd>
    </dl>
  </section>
    
  <section
      class="summary offset-anchor"
      id="instance-properties">
    <h2>Properties</h2>
    <dl class="properties">
        <dt id="codec" class="property">
  <span class="name"><a href="../public_flutter_sound_player/FlutterSoundPlayer/codec.html">codec</a></span>
  <span class="signature">&#8596; <a href="https://pub.dev/documentation/flutter_sound_platform_interface/9.28.0/flutter_sound_platform_interface/Codec.html">Codec</a></span>
  

</dt>
<dd>
  
  <div class="features"><span class="feature">getter/setter pair</span></div>

</dd>

        <dt id="float32Sink" class="property">
  <span class="name"><a href="../public_flutter_sound_player/FlutterSoundPlayer/float32Sink.html">float32Sink</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-async/StreamSink-class.html">StreamSink</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.flutter.dev/flutter/dart-core/List-class.html">List</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.flutter.dev/flutter/dart-typed_data/Float32List-class.html">Float32List</a></span>&gt;</span></span>&gt;</span>?</span>
  

</dt>
<dd>
  Getter of one of the three StreamSink that you may use to feed a player from Stream.
  <div class="features"><span class="feature">no setter</span></div>

</dd>

        <dt id="foodSink" class="property">
  <span class="name"><a class="deprecated" href="../public_flutter_sound_player/FlutterSoundPlayer/foodSink.html">foodSink</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-async/StreamSink-class.html">StreamSink</a><span class="signature">&lt;<wbr><span class="type-parameter">Food</span>&gt;</span>?</span>
  

</dt>
<dd>
  The sink side of the Food Controller. Deprecated.
  <div class="features"><span class="feature">no setter</span></div>

</dd>

        <dt id="hashCode" class="property inherited">
  <span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/hashCode.html">hashCode</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span>
  

</dt>
<dd class="inherited">
  The hash code for this object.
  <div class="features"><span class="feature">no setter</span><span class="feature">inherited</span></div>

</dd>

        <dt id="int16Sink" class="property">
  <span class="name"><a href="../public_flutter_sound_player/FlutterSoundPlayer/int16Sink.html">int16Sink</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-async/StreamSink-class.html">StreamSink</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.flutter.dev/flutter/dart-core/List-class.html">List</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.flutter.dev/flutter/dart-typed_data/Int16List-class.html">Int16List</a></span>&gt;</span></span>&gt;</span>?</span>
  

</dt>
<dd>
  Getter of one of the three StreamSink that you may use to feed a player from Stream.
  <div class="features"><span class="feature">no setter</span></div>

</dd>

        <dt id="interleaved" class="property">
  <span class="name"><a href="../public_flutter_sound_player/FlutterSoundPlayer/interleaved.html">interleaved</a></span>
  <span class="signature">&#8596; <a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span>
  

</dt>
<dd>
  
  <div class="features"><span class="feature">getter/setter pair</span></div>

</dd>

        <dt id="isPaused" class="property">
  <span class="name"><a href="../public_flutter_sound_player/FlutterSoundPlayer/isPaused.html">isPaused</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span>
  

</dt>
<dd>
  Test the Player State
  <div class="features"><span class="feature">no setter</span></div>

</dd>

        <dt id="isPlaying" class="property">
  <span class="name"><a href="../public_flutter_sound_player/FlutterSoundPlayer/isPlaying.html">isPlaying</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span>
  

</dt>
<dd>
  Test the Player State
  <div class="features"><span class="feature">no setter</span></div>

</dd>

        <dt id="isStopped" class="property">
  <span class="name"><a href="../public_flutter_sound_player/FlutterSoundPlayer/isStopped.html">isStopped</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span>
  

</dt>
<dd>
  Test the Player State
  <div class="features"><span class="feature">no setter</span></div>

</dd>

        <dt id="logger" class="property">
  <span class="name"><a href="../public_flutter_sound_player/FlutterSoundPlayer/logger.html">logger</a></span>
  <span class="signature">&#8594; <a href="https://pub.dev/documentation/logger/2.5.0/logger/Logger-class.html">Logger</a></span>
  

</dt>
<dd>
  The getter of the FlutterSoundPlayer Logger
  <div class="features"><span class="feature">no setter</span></div>

</dd>

        <dt id="numChannels" class="property">
  <span class="name"><a href="../public_flutter_sound_player/FlutterSoundPlayer/numChannels.html">numChannels</a></span>
  <span class="signature">&#8596; <a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span>
  

</dt>
<dd>
  
  <div class="features"><span class="feature">getter/setter pair</span></div>

</dd>

        <dt id="onProgress" class="property">
  <span class="name"><a href="../public_flutter_sound_player/FlutterSoundPlayer/onProgress.html">onProgress</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/Stream-class.html">Stream</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="../public_flutter_sound_player/PlaybackDisposition-class.html">PlaybackDisposition</a></span>&gt;</span>?</span>
  

</dt>
<dd>
  The stream side of the <a href="../public_flutter_sound_player/FlutterSoundPlayer/onProgress.html">onProgress</a> Controller
  <div class="features"><span class="feature">no setter</span></div>

</dd>

        <dt id="playerState" class="property">
  <span class="name"><a href="../public_flutter_sound_player/FlutterSoundPlayer/playerState.html">playerState</a></span>
  <span class="signature">&#8594; <a href="../public_flutter_sound_player/PlayerState.html">PlayerState</a></span>
  

</dt>
<dd>
  Getter of the current state of the Player
  <div class="features"><span class="feature">no setter</span></div>

</dd>

        <dt id="runtimeType" class="property inherited">
  <span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html">runtimeType</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/Type-class.html">Type</a></span>
  

</dt>
<dd class="inherited">
  A representation of the runtime type of the object.
  <div class="features"><span class="feature">no setter</span><span class="feature">inherited</span></div>

</dd>

        <dt id="uint8ListSink" class="property">
  <span class="name"><a href="../public_flutter_sound_player/FlutterSoundPlayer/uint8ListSink.html">uint8ListSink</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-async/StreamSink-class.html">StreamSink</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.flutter.dev/flutter/dart-typed_data/Uint8List-class.html">Uint8List</a></span>&gt;</span>?</span>
  

</dt>
<dd>
  Getter of one of the three StreamSink that you may use to feed a player from Stream.
  <div class="features"><span class="feature">no setter</span></div>

</dd>

    </dl>
  </section>

    
  <section
      class="summary offset-anchor"
      id="instance-methods">
    <h2>Methods</h2>
    <dl class="callables">
        <dt id="closePlayer" class="callable">
  <span class="name"><a href="../public_flutter_sound_player/FlutterSoundPlayer/closePlayer.html">closePlayer</a></span><span class="signature">(<wbr>)
    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/Future-class.html">Future</a><span class="signature">&lt;<wbr><span class="type-parameter">void</span>&gt;</span></span>
  </span>
  

</dt>
<dd>
  Close an open player.
  

</dd>

        <dt id="feedF32FromStream" class="callable">
  <span class="name"><a href="../public_flutter_sound_player/FlutterSoundPlayer/feedF32FromStream.html">feedF32FromStream</a></span><span class="signature">(<wbr><span class="parameter" id="feedF32FromStream-param-buffer"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/List-class.html">List</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.flutter.dev/flutter/dart-typed_data/Float32List-class.html">Float32List</a></span>&gt;</span></span> <span class="parameter-name">buffer</span></span>)
    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/Future-class.html">Future</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span>&gt;</span></span>
  </span>
  

</dt>
<dd>
  Feed a Float32 stream not interleaved when a flow control is wanted
  

</dd>

        <dt id="feedFromStream" class="callable">
  <span class="name deprecated"><a class="deprecated" href="../public_flutter_sound_player/FlutterSoundPlayer/feedFromStream.html">feedFromStream</a></span><span class="signature">(<wbr><span class="parameter" id="feedFromStream-param-buffer"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-typed_data/Uint8List-class.html">Uint8List</a></span> <span class="parameter-name">buffer</span></span>)
    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/Future-class.html">Future</a><span class="signature">&lt;<wbr><span class="type-parameter">void</span>&gt;</span></span>
  </span>
  

</dt>
<dd>
  Used when you want to play live PCM data synchronously.
  

</dd>

        <dt id="feedInt16FromStream" class="callable">
  <span class="name"><a href="../public_flutter_sound_player/FlutterSoundPlayer/feedInt16FromStream.html">feedInt16FromStream</a></span><span class="signature">(<wbr><span class="parameter" id="feedInt16FromStream-param-buffer"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/List-class.html">List</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.flutter.dev/flutter/dart-typed_data/Int16List-class.html">Int16List</a></span>&gt;</span></span> <span class="parameter-name">buffer</span></span>)
    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/Future-class.html">Future</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span>&gt;</span></span>
  </span>
  

</dt>
<dd>
  Feed a Int16 stream not interleaved when a flow control is wanted
  

</dd>

        <dt id="feedUint8FromStream" class="callable">
  <span class="name"><a href="../public_flutter_sound_player/FlutterSoundPlayer/feedUint8FromStream.html">feedUint8FromStream</a></span><span class="signature">(<wbr><span class="parameter" id="feedUint8FromStream-param-buffer"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-typed_data/Uint8List-class.html">Uint8List</a></span> <span class="parameter-name">buffer</span></span>)
    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/Future-class.html">Future</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span>&gt;</span></span>
  </span>
  

</dt>
<dd>
  Feed a UInt8 stream interleaved when a flow control is wanted
  

</dd>

        <dt id="getPlayerState" class="callable">
  <span class="name"><a href="../public_flutter_sound_player/FlutterSoundPlayer/getPlayerState.html">getPlayerState</a></span><span class="signature">(<wbr>)
    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/Future-class.html">Future</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="../public_flutter_sound_player/PlayerState.html">PlayerState</a></span>&gt;</span></span>
  </span>
  

</dt>
<dd>
  Query the current state of the Flutter Sound Core layer.
  

</dd>

        <dt id="getProgress" class="callable">
  <span class="name deprecated"><a class="deprecated" href="../public_flutter_sound_player/FlutterSoundPlayer/getProgress.html">getProgress</a></span><span class="signature">(<wbr>)
    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/Future-class.html">Future</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.flutter.dev/flutter/dart-core/Map-class.html">Map</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span>, <span class="type-parameter"><a href="https://api.flutter.dev/flutter/dart-core/Duration-class.html">Duration</a></span>&gt;</span></span>&gt;</span></span>
  </span>
  

</dt>
<dd>
  Get the current progress of a playback.
  

</dd>

        <dt id="isDecoderSupported" class="callable">
  <span class="name"><a href="../public_flutter_sound_player/FlutterSoundPlayer/isDecoderSupported.html">isDecoderSupported</a></span><span class="signature">(<wbr><span class="parameter" id="isDecoderSupported-param-codec"><span class="type-annotation"><a href="https://pub.dev/documentation/flutter_sound_platform_interface/9.28.0/flutter_sound_platform_interface/Codec.html">Codec</a></span> <span class="parameter-name">codec</span></span>)
    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/Future-class.html">Future</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span>&gt;</span></span>
  </span>
  

</dt>
<dd>
  Returns true if the specified decoder is supported by Flutter Sound on this platform
  

</dd>

        <dt id="isOpen" class="callable">
  <span class="name"><a href="../public_flutter_sound_player/FlutterSoundPlayer/isOpen.html">isOpen</a></span><span class="signature">(<wbr>)
    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span>
  </span>
  

</dt>
<dd>
  Return true if the Player has been open.
  

</dd>

        <dt id="noSuchMethod" class="callable inherited">
  <span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html">noSuchMethod</a></span><span class="signature">(<wbr><span class="parameter" id="noSuchMethod-param-invocation"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/Invocation-class.html">Invocation</a></span> <span class="parameter-name">invocation</span></span>)
    <span class="returntype parameter">&#8594; dynamic</span>
  </span>
  

</dt>
<dd class="inherited">
  Invoked when a nonexistent method or property is accessed.
  <div class="features"><span class="feature">inherited</span></div>

</dd>

        <dt id="openPlayer" class="callable">
  <span class="name"><a href="../public_flutter_sound_player/FlutterSoundPlayer/openPlayer.html">openPlayer</a></span><span class="signature">(<wbr>{<span class="parameter" id="openPlayer-param-isBGService"><span class="type-annotation">dynamic</span> <span class="parameter-name">isBGService</span> = <span class="default-value">false</span></span>})
    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/Future-class.html">Future</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="../public_flutter_sound_player/FlutterSoundPlayer-class.html">FlutterSoundPlayer</a>?</span>&gt;</span></span>
  </span>
  

</dt>
<dd>
  Open the Player.
  

</dd>

        <dt id="pausePlayer" class="callable">
  <span class="name"><a href="../public_flutter_sound_player/FlutterSoundPlayer/pausePlayer.html">pausePlayer</a></span><span class="signature">(<wbr>)
    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/Future-class.html">Future</a><span class="signature">&lt;<wbr><span class="type-parameter">void</span>&gt;</span></span>
  </span>
  

</dt>
<dd>
  Pause the current playback.
  

</dd>

        <dt id="resumePlayer" class="callable">
  <span class="name"><a href="../public_flutter_sound_player/FlutterSoundPlayer/resumePlayer.html">resumePlayer</a></span><span class="signature">(<wbr>)
    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/Future-class.html">Future</a><span class="signature">&lt;<wbr><span class="type-parameter">void</span>&gt;</span></span>
  </span>
  

</dt>
<dd>
  Resume the current playback.
  

</dd>

        <dt id="seekToPlayer" class="callable">
  <span class="name"><a href="../public_flutter_sound_player/FlutterSoundPlayer/seekToPlayer.html">seekToPlayer</a></span><span class="signature">(<wbr><span class="parameter" id="seekToPlayer-param-duration"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/Duration-class.html">Duration</a></span> <span class="parameter-name">duration</span></span>)
    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/Future-class.html">Future</a><span class="signature">&lt;<wbr><span class="type-parameter">void</span>&gt;</span></span>
  </span>
  

</dt>
<dd>
  To seek to a new location.
  

</dd>

        <dt id="setLogLevel" class="callable">
  <span class="name"><a href="../public_flutter_sound_player/FlutterSoundPlayer/setLogLevel.html">setLogLevel</a></span><span class="signature">(<wbr><span class="parameter" id="setLogLevel-param-aLevel"><span class="type-annotation"><a href="https://pub.dev/documentation/logger/2.5.0/logger/Level.html">Level</a></span> <span class="parameter-name">aLevel</span></span>)
    <span class="returntype parameter">&#8594; void</span>
  </span>
  

</dt>
<dd>
  Used if the App wants to dynamically change the Log Level.
  

</dd>

        <dt id="setSpeed" class="callable">
  <span class="name"><a href="../public_flutter_sound_player/FlutterSoundPlayer/setSpeed.html">setSpeed</a></span><span class="signature">(<wbr><span class="parameter" id="setSpeed-param-speed"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/double-class.html">double</a></span> <span class="parameter-name">speed</span></span>)
    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/Future-class.html">Future</a><span class="signature">&lt;<wbr><span class="type-parameter">void</span>&gt;</span></span>
  </span>
  

</dt>
<dd>
  Change the playback speed
  

</dd>

        <dt id="setSubscriptionDuration" class="callable">
  <span class="name"><a href="../public_flutter_sound_player/FlutterSoundPlayer/setSubscriptionDuration.html">setSubscriptionDuration</a></span><span class="signature">(<wbr><span class="parameter" id="setSubscriptionDuration-param-duration"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/Duration-class.html">Duration</a></span> <span class="parameter-name">duration</span></span>)
    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/Future-class.html">Future</a><span class="signature">&lt;<wbr><span class="type-parameter">void</span>&gt;</span></span>
  </span>
  

</dt>
<dd>
  Specify the callbacks frequency of the <a href="../public_flutter_sound_player/FlutterSoundPlayer/onProgress.html">onProgress</a> stream.
  

</dd>

        <dt id="setVolume" class="callable">
  <span class="name"><a href="../public_flutter_sound_player/FlutterSoundPlayer/setVolume.html">setVolume</a></span><span class="signature">(<wbr><span class="parameter" id="setVolume-param-volume"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/double-class.html">double</a></span> <span class="parameter-name">volume</span></span>)
    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/Future-class.html">Future</a><span class="signature">&lt;<wbr><span class="type-parameter">void</span>&gt;</span></span>
  </span>
  

</dt>
<dd>
  Change the output volume
  

</dd>

        <dt id="setVolumePan" class="callable">
  <span class="name"><a href="../public_flutter_sound_player/FlutterSoundPlayer/setVolumePan.html">setVolumePan</a></span><span class="signature">(<wbr><span class="parameter" id="setVolumePan-param-volume"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/double-class.html">double</a></span> <span class="parameter-name">volume</span>, </span><span class="parameter" id="setVolumePan-param-pan"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/double-class.html">double</a></span> <span class="parameter-name">pan</span></span>)
    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/Future-class.html">Future</a><span class="signature">&lt;<wbr><span class="type-parameter">void</span>&gt;</span></span>
  </span>
  

</dt>
<dd>
  FIXME : documentation of this verb
  

</dd>

        <dt id="startPlayer" class="callable">
  <span class="name"><a href="../public_flutter_sound_player/FlutterSoundPlayer/startPlayer.html">startPlayer</a></span><span class="signature">(<wbr>{<span class="parameter" id="startPlayer-param-codec"><span class="type-annotation"><a href="https://pub.dev/documentation/flutter_sound_platform_interface/9.28.0/flutter_sound_platform_interface/Codec.html">Codec</a></span> <span class="parameter-name">codec</span> = <span class="default-value">Codec.aacADTS</span>, </span><span class="parameter" id="startPlayer-param-fromURI"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a>?</span> <span class="parameter-name">fromURI</span>, </span><span class="parameter" id="startPlayer-param-fromDataBuffer"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-typed_data/Uint8List-class.html">Uint8List</a>?</span> <span class="parameter-name">fromDataBuffer</span>, </span><span class="parameter" id="startPlayer-param-sampleRate"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span> <span class="parameter-name">sampleRate</span> = <span class="default-value">16000</span>, </span><span class="parameter" id="startPlayer-param-numChannels"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span> <span class="parameter-name">numChannels</span> = <span class="default-value">1</span>, </span><span class="parameter" id="startPlayer-param-whenFinished"><span class="type-annotation"><a href="../public_flutter_sound_player/TWhenFinished.html">TWhenFinished</a>?</span> <span class="parameter-name">whenFinished</span></span>})
    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/Future-class.html">Future</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.flutter.dev/flutter/dart-core/Duration-class.html">Duration</a>?</span>&gt;</span></span>
  </span>
  

</dt>
<dd>
  Used to play a sound on a player open with <a href="../public_flutter_sound_player/FlutterSoundPlayer/openPlayer.html">openPlayer()</a>.
  

</dd>

        <dt id="startPlayerFromMic" class="callable">
  <span class="name deprecated"><a class="deprecated" href="../public_flutter_sound_player/FlutterSoundPlayer/startPlayerFromMic.html">startPlayerFromMic</a></span><span class="signature">(<wbr>{<span class="parameter" id="startPlayerFromMic-param-sampleRate"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span> <span class="parameter-name">sampleRate</span> = <span class="default-value">44000</span>, </span><span class="parameter" id="startPlayerFromMic-param-numChannels"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span> <span class="parameter-name">numChannels</span> = <span class="default-value">1</span>, </span><span class="parameter" id="startPlayerFromMic-param-bufferSize"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span> <span class="parameter-name">bufferSize</span> = <span class="default-value">8192</span>, </span><span class="parameter" id="startPlayerFromMic-param-enableVoiceProcessing"><span class="type-annotation">dynamic</span> <span class="parameter-name">enableVoiceProcessing</span> = <span class="default-value">false</span></span>})
    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/Future-class.html">Future</a><span class="signature">&lt;<wbr><span class="type-parameter">void</span>&gt;</span></span>
  </span>
  

</dt>
<dd>
  Starts the Microphone and plays what is recorded.
  

</dd>

        <dt id="startPlayerFromStream" class="callable">
  <span class="name"><a href="../public_flutter_sound_player/FlutterSoundPlayer/startPlayerFromStream.html">startPlayerFromStream</a></span><span class="signature">(<wbr>{<span class="parameter" id="startPlayerFromStream-param-codec"><span>required</span> <span class="type-annotation"><a href="https://pub.dev/documentation/flutter_sound_platform_interface/9.28.0/flutter_sound_platform_interface/Codec.html">Codec</a></span> <span class="parameter-name">codec</span>, </span><span class="parameter" id="startPlayerFromStream-param-interleaved"><span>required</span> <span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span> <span class="parameter-name">interleaved</span>, </span><span class="parameter" id="startPlayerFromStream-param-numChannels"><span>required</span> <span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span> <span class="parameter-name">numChannels</span>, </span><span class="parameter" id="startPlayerFromStream-param-sampleRate"><span>required</span> <span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span> <span class="parameter-name">sampleRate</span>, </span><span class="parameter" id="startPlayerFromStream-param-bufferSize"><span>required</span> <span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span> <span class="parameter-name">bufferSize</span>, </span><span class="parameter" id="startPlayerFromStream-param-onBufferUnderlow"><span class="type-annotation"><a href="../public_flutter_sound_player/TWhenFinished.html">TWhenFinished</a>?</span> <span class="parameter-name">onBufferUnderlow</span></span>})
    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/Future-class.html">Future</a><span class="signature">&lt;<wbr><span class="type-parameter">void</span>&gt;</span></span>
  </span>
  

</dt>
<dd>
  Used to play something from a dart stream
  

</dd>

        <dt id="stopPlayer" class="callable">
  <span class="name"><a href="../public_flutter_sound_player/FlutterSoundPlayer/stopPlayer.html">stopPlayer</a></span><span class="signature">(<wbr>)
    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/Future-class.html">Future</a><span class="signature">&lt;<wbr><span class="type-parameter">void</span>&gt;</span></span>
  </span>
  

</dt>
<dd>
  Stop a player.
  

</dd>

        <dt id="toString" class="callable inherited">
  <span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/toString.html">toString</a></span><span class="signature">(<wbr>)
    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span>
  </span>
  

</dt>
<dd class="inherited">
  A string representation of this object.
  <div class="features"><span class="feature">inherited</span></div>

</dd>

    </dl>
  </section>
    
  <section
      class="summary offset-anchor inherited"
      id="operators">
    <h2>Operators</h2>
    <dl class="callables">
        <dt id="operator ==" class="callable inherited">
  <span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html">operator ==</a></span><span class="signature">(<wbr><span class="parameter" id="==-param-other"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/Object-class.html">Object</a></span> <span class="parameter-name">other</span></span>)
    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span>
  </span>
  

</dt>
<dd class="inherited">
  The equality operator.
  <div class="features"><span class="feature">inherited</span></div>

</dd>

    </dl>
  </section>
    
    
    

  </div> <!-- /.main-content -->
  <div id="dartdoc-sidebar-left" class="sidebar sidebar-offcanvas-left">
    <!-- The search input and breadcrumbs below are only responsively visible at low resolutions. -->
<header id="header-search-sidebar" class="hidden-l">
  <form class="search-sidebar" role="search">
    <input type="text" id="search-sidebar" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
  </form>
</header>
<ol class="breadcrumbs gt-separated dark hidden-l" id="sidebar-nav">
    <li><a href="../index.html">flutter_sound</a></li>
    <li><a href="../public_flutter_sound_player">flutter_sound_player</a></li>
    <li class="self-crumb">FlutterSoundPlayer class</li>
</ol>

    <h5>flutter_sound_player library</h5>
    <div id="dartdoc-sidebar-left-content"></div>
  </div>
  <div id="dartdoc-sidebar-right" class="sidebar sidebar-offcanvas-right">
  </div><!--/.sidebar-offcanvas-->
</main>
<footer>
  <span class="no-break">
    flutter_sound
      9.28.0
  </span>
  
</footer>


<script src="../static-assets/highlight.pack.js?v1"></script>
<script src="../static-assets/docs.dart.js"></script>

</body>
</html>

